<html>
   <head>
      <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   
      <link rel="stylesheet" href="./../helpwin.css">
      <title>MATLAB File Help: prtPreProcHistEq</title>
   </head>
   <body>
      <!--Single-page help-->
      <table border="0" cellspacing="0" width="100%">
         <tr class="subheader">
            <td class="headertitle">MATLAB File Help: prtPreProcHistEq</td>
            
            
         </tr>
      </table>
      <div class="title">prtPreProcHistEq</div>
      <div class="helptext"><pre><!--helptext -->  <span class="helptopic">prtPreProcHistEq</span>   Histogram equalization pre-processing
 
    HISTEQ = <span class="helptopic">prtPreProcHistEq</span> creates a histogram equalization pre
    processing object. A <span class="helptopic">prtPreProcHistEq</span> object processes the input
    data
    so that the distribution of each feature is approximately uniform
    in the range [0,1].
 
    <span class="helptopic">prtPreProcHistEq</span> has the following properties:
 
    nSamples    - The number of samples to use when learning the
                histogtram of the training data.  The default is inf
                (which uses all the data), however for large data sets
                this can be slow.
 
    A <span class="helptopic">prtPreProcHistEq</span> object also inherits all properties and functions from
    the prtAction class
 
    Example:
 
    dataSet = prtDataGenIris;              % Load a data set
    dataSet = dataSet.retainFeatures(1:2); % Use only the first 2
                                           % Features
    histEq = <span class="helptopic">prtPreProcHistEq</span>;             % Create the
                                           % <span class="helptopic">prtPreProcHistEq</span> Object
 
    histEq = histEq.train(dataSet);        % Train the object
    dataSetNew = histEq.run(dataSet);      % Equalize the histogram
 
    % Plot
    subplot(2,1,1); plot(dataSet);
    title('Original Data');
    subplot(2,1,2); plot(dataSetNew);
    title('HistEq Data');</pre></div><!--after help --><!--seeAlso--><div class="footerlinktitle">See Also</div><div class="footerlink"> <a href="./prtPreProc.html">prtPreProc</a>, <a href="./prtPreProcPca.html">prtPreProcPca</a>, <a href="./prtPreProcPls.html">prtPreProcPls</a>,
    <a href="./prtPreProcHistEq/prtPreProcHistEq.html">prtPreProcHistEq</a>, <a href="./prtPreProcZeroMeanColumns.html">prtPreProcZeroMeanColumns</a>, <a href="./prtPreProcLda.html">prtPreProcLda</a>,
    <a href="./prtPreProcZeroMeanRows.html">prtPreProcZeroMeanRows</a>, <a href="./prtPreProcLogDisc.html">prtPreProcLogDisc</a>, <a href="./prtPreProcZmuv.html">prtPreProcZmuv</a>,
    <a href="./prtPreProcMinMaxRows.html">prtPreProcMinMaxRows</a>
</div>
      <!--Class-->
      <div class="sectiontitle">Class Details</div>
      <table class="class-details">
         <tr>
            <td class="class-detail-label">Superclasses</td>
            <td><a href="./prtPreProc.html">prtPreProc</a></td>
         </tr>
         <tr>
            <td class="class-detail-label">Sealed</td>
            <td>false</td>
         </tr>
         <tr>
            <td class="class-detail-label">Construct on load</td>
            <td>false</td>
         </tr>
      </table>
      <!--Constructors-->
      <div class="sectiontitle"><a name="constructors"></a>Constructor Summary
      </div>
      <table class="summary-list">
         <tr class="summary-item">
            <td class="name"><a href="./prtPreProcHistEq/prtPreProcHistEq.html">prtPreProcHistEq</a></td>
            <td class="m-help">Allow for string, value pairs&nbsp;</td>
         </tr>
      </table>
      <!--Properties-->
      <div class="sectiontitle"><a name="properties"></a>Property Summary
      </div>
      <table class="summary-list">
         <tr class="summary-item">
            <td class="name"><a href="./prtPreProcHistEq/binEdges.html">binEdges</a></td>
            <td class="m-help">The bin edges&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtPreProcHistEq/dataSet.html">dataSet</a></td>
            <td class="m-help">The training prtDataSet, only stored if verboseStorage is true. &nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtPreProcHistEq/dataSetSummary.html">dataSetSummary</a></td>
            <td class="m-help">Structure that summarizes prtDataSet.&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtPreProcHistEq/isCrossValidateValid.html">isCrossValidateValid</a></td>
            <td class="m-help">True&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtPreProcHistEq/isSupervised.html">isSupervised</a></td>
            <td class="m-help">False&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtPreProcHistEq/isTrained.html">isTrained</a></td>
            <td class="m-help">Indicates if prtAction object has been trained.&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtPreProcHistEq/nSamples.html">nSamples</a></td>
            <td class="m-help">The number of samples to process.&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtPreProcHistEq/name.html">name</a></td>
            <td class="m-help">Histogram Equalization&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtPreProcHistEq/nameAbbreviation.html">nameAbbreviation</a></td>
            <td class="m-help">HistEq&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtPreProcHistEq/showProgressBar.html">showProgressBar</a></td>
            <td class="m-help">&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtPreProcHistEq/userData.html">userData</a></td>
            <td class="m-help">User specified data&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtPreProcHistEq/verboseStorage.html">verboseStorage</a></td>
            <td class="m-help">Specifies whether or not to store the training prtDataset.&nbsp;</td>
         </tr>
      </table>
      <!--Methods-->
      <div class="sectiontitle"><a name="methods"></a>Method Summary
      </div>
      <table class="summary-list">
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtPreProcHistEq/crossValidate.html">crossValidate</a></td>
            <td class="m-help">Cross validate prtAction using prtDataSet and cross validation keys.&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtPreProcHistEq/get.html">get</a></td>
            <td class="m-help">get the object properties&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtPreProcHistEq/kfolds.html">kfolds</a></td>
            <td class="m-help">Perform K-folds cross-validation of prtAction&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtPreProcHistEq/optimize.html">optimize</a></td>
            <td class="m-help">Optimize action parameter by exhaustive function maximization.&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtPreProcHistEq/run.html">run</a></td>
            <td class="m-help">Run a prtAction object on a prtDataSet object.&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtPreProcHistEq/set.html">set</a></td>
            <td class="m-help">set the object properties&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtPreProcHistEq/train.html">train</a></td>
            <td class="m-help">Train a prtAction object using training a prtDataSet object.&nbsp;</td>
         </tr>
      </table>
   </body>
</html>